Skip to content

docs(readme): correct lean-ctx comparison row#1754

Open
ketpatil77 wants to merge 1 commit into
headroomlabs-ai:mainfrom
ketpatil77:codex/headroom-lean-ctx-table
Open

docs(readme): correct lean-ctx comparison row#1754
ketpatil77 wants to merge 1 commit into
headroomlabs-ai:mainfrom
ketpatil77:codex/headroom-lean-ctx-table

Conversation

@ketpatil77

@ketpatil77 ketpatil77 commented Jul 3, 2026

Copy link
Copy Markdown

Description

Correct the lean-ctx row in the README comparison table.

The upstream project documents reversible recovery paths and broader deployment surfaces than the table previously reflected.

Closes #1754

Type of Change

  • Documentation update

Changes Made

  • README.md: updated lean-ctx comparison row to match current documented capabilities and reversible behavior.

Testing

  • Unit tests pass (pytest)
  • Linting passes (ruff check .)
  • Type checking passes (mypy headroom)
  • New tests added for new functionality
  • Manual testing performed

Test Output

Docs-only verification:
- Reviewed rendered README diff for the comparison row.
- Cross-checked updated row against current public lean-ctx docs covering deployment surfaces and reversible behavior.

Real Behavior Proof

  • Environment: GitHub PR diff review for docs-only comparison-table update.
  • Exact command / steps: Compared new README row wording against current public lean-ctx documentation.
  • Observed result: Comparison row now matches documented capabilities instead of understating recovery and deployment support.
  • Not tested: Runtime commands; docs-only change.

Review Readiness

  • I have performed a self-review
  • This PR is ready for human review

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have updated the CHANGELOG.md if applicable

@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

PR governance

This PR follows the template and is marked ready for human review.

@github-actions github-actions Bot added the status: needs author action Pull request body or readiness checklist still needs author updates label Jul 3, 2026

@JerrettDavis JerrettDavis left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the README comparison change and cross-checked it against current lean-ctx public docs. The updated row better reflects its broader read surfaces, opt-in request proxy, MCP/API surface, and reversible/replayable context positioning. Docs-only change; this looks ready.

@github-actions github-actions Bot added status: ready for review Pull request body is complete and the author marked it ready for human review and removed status: needs author action Pull request body or readiness checklist still needs author updates labels Jul 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: ready for review Pull request body is complete and the author marked it ready for human review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants